home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il_c / ilPolyadicImg.z / ilPolyadicImg
Encoding:
Text File  |  2002-10-03  |  15.2 KB  |  331 lines
  1.  
  2.  
  3.  
  4. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg - base class for N-input operators
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage : ilCacheImg : ilMemCacheImg : ilOpImg
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilCdefs.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilPolyadicImg is the base class for IL operator images with multiple
  19.      input (parent) images. This class is only useable when derived from to
  20.      define the processing to be perform using the virtual, ccccaaaallllccccPPPPaaaaggggeeee(); there
  21.      is no public constructor.
  22.  
  23. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  24.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  25.  
  26.      GGGGeeeetttt////sssseeeetttt mmmmeeeetttthhhhooooddddssss
  27.  
  28.           void ilPolyadicImgSetOffset(ilPolyadicImg *obj, int x,
  29.                                       int y, int z , int idx)
  30.           ilStatus ilPolyadicImgGetOffset(ilPolyadicImg *obj, int *x,
  31.                                           int *y, int *z, int idx)
  32.           iflXYZint* ilPolyadicImgGetOffsets(ilPolyadicImg *obj)
  33.           int ilPolyadicImgGetNumActiveInputs(ilPolyadicImg *obj)
  34.           ilImage* ilPolyadicImgGetActiveInput(ilPolyadicImg *obj,
  35.                                                int idx)
  36.           ilStatus ilPolyadicImgGetActiveOffset(ilPolyadicImg *obj,
  37.                                                 int *x, int *y,
  38.                                                 int *z, int idx)
  39.           double ilPolyadicImgGetActiveInputMin(ilPolyadicImg *obj,
  40.                                                 int idx)
  41.           double ilPolyadicImgGetActiveInputMax(ilPolyadicImg *obj,
  42.                                                 int idx)
  43.  
  44.      DDDDeeeeffffiiiinnnniiiinnnngggg tttthhhheeee iiiimmmmaaaaggggeeee pppprrrroooocccceeeessssssssiiiinnnngggg ooooppppeeeerrrraaaattttiiiioooonnnn
  45.  
  46. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  47.      iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg(((())))
  48.  
  49.           The constructor take a single argument, _n_u_m_I_n_p_u_t_s, that specifies
  50.           the maximum number of inputs that a derived class will accept.  The
  51.           default value, -1, indicates that an unlimited number of inputs are
  52.           allowed.
  53.  
  54.      ggggeeeettttAAAAccccttttiiiivvvveeeeIIIInnnnppppuuuutttt(((())))
  55.  
  56.           ilImage* ilPolyadicImgGetActiveInput(ilPolyadicImg *obj,
  57.                                                int idx)
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  71.  
  72.  
  73.  
  74.           This method returns the _i_d_x'th active input (zero relative).  An
  75.           active input is any input that is non-NULL.
  76.  
  77.      ggggeeeettttAAAAccccttttiiiivvvveeeeIIIInnnnppppuuuuttttMMMMaaaaxxxx(((())))
  78.  
  79.           double ilPolyadicImgGetActiveInputMax(ilPolyadicImg *obj,
  80.                                                 int idx)
  81.  
  82.  
  83.           This method returns the maximum pixel value of the _i_d_x'th active
  84.           input (zero relative).  An active input is any input that is non-
  85.           NULL.
  86.  
  87.      ggggeeeettttAAAAccccttttiiiivvvveeeeIIIInnnnppppuuuuttttMMMMiiiinnnn(((())))
  88.  
  89.           double ilPolyadicImgGetActiveInputMin(ilPolyadicImg *obj,
  90.                                                 int idx)
  91.  
  92.  
  93.           This method returns the minimum pixel value of the _i_d_x'th active
  94.           input (zero relative).  An active input is any input that is non-
  95.           NULL.
  96.  
  97.      ggggeeeettttAAAAccccttttiiiivvvveeeeOOOOffffffffsssseeeetttt(((())))
  98.  
  99.           ilStatus ilPolyadicImgGetActiveOffset(ilPolyadicImg *obj,
  100.                                                 int *x, int *y,
  101.                                                 int *z, int i )
  102.  
  103.  
  104.           This method returns the (_x,_y,_z) offsets of the _i_d_x'th active input
  105.           (zero relative). An active input is any input that is non-NULL.
  106.           Those offsets are subtracted from the page origin in
  107.           pppprrrreeeeppppaaaarrrreeeeRRRReeeeqqqquuuueeeesssstttt() to determine the tile to be accessed from the
  108.           indicated input.
  109.  
  110.      ggggeeeettttNNNNuuuummmmAAAAccccttttiiiivvvveeeeIIIInnnnppppuuuuttttssss(((())))
  111.  
  112.           int ilPolyadicImgGetNumActiveInputs(ilPolyadicImg *obj)
  113.  
  114.  
  115.           This method returns the number of active (non-NULL) inputs.
  116.  
  117.      ggggeeeettttOOOOffffffffsssseeeetttt(((())))
  118.  
  119.           ilStatus ilPolyadicImgGetOffset(ilPolyadicImg *obj, int *x,
  120.                                           int *y, int *z, int idx)
  121.  
  122.  
  123.           This method returns the (_x,_y,_z) offsets of the _i_d_x'th input (zero
  124.           relative). Those offsets are subtracted from the page origin in
  125.           pppprrrreeeeppppaaaarrrreeeeRRRReeeeqqqquuuueeeesssstttt() to determine the tile to be accessed from the
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  137.  
  138.  
  139.  
  140.           indicated input.
  141.  
  142.      ggggeeeettttOOOOffffffffsssseeeettttssss(((())))
  143.  
  144.           iflXYZint* ilPolyadicImgGetOffsets(ilPolyadicImg *obj)
  145.  
  146.  
  147.           This method returns an array of offsets (as iflXYZint's) for all of
  148.           the inputs.  Set ggggeeeettttOOOOffffffffsssseeeetttt() for more details on the offset
  149.           interpretation.
  150.  
  151.      sssseeeettttOOOOffffffffsssseeeetttt(((())))
  152.  
  153.           void ilPolyadicImgSetOffset(ilPolyadicImg *obj, int x,
  154.                                       int y, int z , int idx)
  155.  
  156.  
  157.           This method sets the (_x,_y,_z) offsets of the _i_d_x'th input (zero
  158.           relative). Those offsets are subtracted from the page origin in
  159.           pppprrrreeeeppppaaaarrrreeeeRRRReeeeqqqquuuueeeesssstttt() to determine the tile to be accessed from the
  160.           indicated input.
  161.  
  162. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  163.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllOOOOppppIIIImmmmgggg
  164.      ilOpImgClearClamp(), ilOpImgGetBias(), ilOpImgGetClamp(),
  165.      ilOpImgGetValidOrders(), ilOpImgGetValidTypes(), ilOpImgIsClamped(),
  166.      ilOpImgIsPrecisionKept(), ilOpImgKeepPrecision(), ilOpImgSetBias(),
  167.      ilOpImgSetClampMinMax(), ilOpImgSetClamp()
  168.  
  169.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMeeeemmmmCCCCaaaacccchhhheeeeIIIImmmmgggg
  170.      ilMemCacheImgEnableMP(), ilMemCacheImgGetPageTime(),
  171.      ilMemCacheImgGetRetainMode(), ilMemCacheImgGetThrashMode(),
  172.      ilMemCacheImgGetThrashTime(), ilMemCacheImgGetTotalPageTime(),
  173.      ilMemCacheImgIsMPenabled(), ilMemCacheImgSetRetainMode(),
  174.      ilMemCacheImgSetThrashMode()
  175.  
  176.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg
  177.      ilCacheImgFlush(), ilCacheImgGetCacheSize()
  178.  
  179.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  180.      ilAddInput(), ilAllocFillData(), ilClipTile(), ilClipTileAsTile(),
  181.      ilClipTileFloat(), ilClipTileFloatAsTile(),
  182.      ilConfigureRetainedCacheImage(), ilCopy(), ilCopyTile(), ilCopyTile3D(),
  183.      ilCopyTileCfg(), ilFillTile(), ilFillTile3D(), ilFillTileRGB(),
  184.      ilFreeFillData(), ilGetColorImg(), ilGetColorModel(), ilGetColormap(),
  185.      ilGetColormapPtr(), ilGetCompression(), ilGetConfig(), ilGetCsize(),
  186.      ilGetDataType(), ilGetDimensions(), ilGetDirectInput(),
  187.      ilGetDisplayCacheEnable(), ilGetFill(), ilGetFillData(),
  188.      ilGetFillValue(), ilGetHeight(), ilGetHwEnable(), ilGetHwHint(),
  189.      ilGetHwHintName(), ilGetHwIntHint(), ilGetHwIntHintName(), ilGetInput(),
  190.      ilGetInputTileRequirement(), ilGetLockTileSet(), ilGetMappedPageSize(),
  191.      ilGetMappedSize(), ilGetMaxColormapLevels(), ilGetMaxValue(),
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  203.  
  204.  
  205.  
  206.      ilGetMinValue(), ilGetNumChans(), ilGetNumInputs(), ilGetOrder(),
  207.      ilGetOrientation(), ilGetPageBorder(), ilGetPageBorderPtr(),
  208.      ilGetPageBorderX(), ilGetPageBorderY(), ilGetPageBorderZ(),
  209.      ilGetPageCounts(), ilGetPageDelta(), ilGetPageDeltaStruct(),
  210.      ilGetPageDimensions(), ilGetPageIndices(), ilGetPageOrigin(),
  211.      ilGetPageOriginC(), ilGetPageOriginStruct(), ilGetPageOriginX(),
  212.      ilGetPageOriginY(), ilGetPageOriginZ(), ilGetPageSize(),
  213.      ilGetPageSizeBytes(), ilGetPageSizeC(), ilGetPageSizePix(),
  214.      ilGetPageSizeStruct(), ilGetPageSizeVal(), ilGetPageSizeX(),
  215.      ilGetPageSizeXY(), ilGetPageSizeY(), ilGetPageSizeZ(), ilGetPixel(),
  216.      ilGetPixel3D(), ilGetPriority(), ilGetScaleMax(), ilGetScaleMin(),
  217.      ilGetSize(), ilGetSizePtr(), ilGetStrides(), ilGetSubTile(),
  218.      ilGetSubTile3D(), ilGetTile(), ilGetTile3D(), ilGetWidth(), ilGetXsize(),
  219.      ilGetYsize(), ilGetZsize(), ilHasPageBorder(), ilHasPages(),
  220.      ilInitScaleMinMax(), ilIsColorImg(), ilIsIntegral(),
  221.      ilIsMirrorOrientation(), ilIsSigned(), ilIsWritable(), ilLockPage(),
  222.      ilLockPageSet(), ilLockTile(), ilLockTile3D(), ilMapFlipTrans(),
  223.      ilMapFromInput(), ilMapFromInput2D(), ilMapFromInput3D(),
  224.      ilMapFromSource(), ilMapFromSource2D(), ilMapFromSource3D(),
  225.      ilMapOrientation(), ilMapSize(), ilMapTile(), ilMapTileFlipTrans(),
  226.      ilMapTileFloat(), ilMapToInput(), ilMapToInput2D(), ilMapToInput3D(),
  227.      ilMapToSource(), ilMapToSource2D(), ilMapToSource3D(), ilMapXY(),
  228.      ilMapXYFloat(), ilMapXYSign(), ilQCopyTileCfg(), ilQFillTile3D(),
  229.      ilQFillTileRGB(), ilQGetSubTile3D(), ilQGetTile3D(), ilQLockPageSet(),
  230.      ilQSetSubTile3D(), ilQSetTile3D(), ilRemoveHwHint(),
  231.      ilRemoveHwHintName(), ilRemoveInput(), ilSetColorModel(),
  232.      ilSetColormap(), ilSetCompression(), ilSetCsize(), ilSetDataType(),
  233.      ilSetDisplayCacheEnable(), ilSetFill(), ilSetFillValue(),
  234.      ilSetHwEnable(), ilSetHwHint(), ilSetHwIntHint(), ilSetHwIntHintName(),
  235.      ilSetInput(), ilSetMaxColormapLevels(), ilSetMaxValue(), ilSetMinValue(),
  236.      ilSetNumChans(), ilSetOrder(), ilSetOrientation(), ilSetPageBorder(),
  237.      ilSetPageBorderStruct(), ilSetPageSize(), ilSetPageSizeC(),
  238.      ilSetPageSizeStruct(), ilSetPageSizeXY(), ilSetPageSizeZ(), ilSetPixel(),
  239.      ilSetPixel3D(), ilSetPriority(), ilSetScaleMinMax(), ilSetScaleType(),
  240.      ilSetSize(), ilSetSubTile(), ilSetSubTile3D(), ilSetTile(),
  241.      ilSetTile3D(), ilSetXYsize(), ilSetXsize(), ilSetYsize(), ilSetZsize(),
  242.      ilUnlockPage(), ilUnlockPageSet()
  243.  
  244.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  245.      ilLinkClearSet(), ilLinkClearStatus(), ilLinkGetDescription(),
  246.      ilLinkGetDirectParent(), ilLinkGetDisabledIndex(), ilLinkGetFloatProp(),
  247.      ilLinkGetGenerationID(), ilLinkGetIntProp(), ilLinkGetNumChildren(),
  248.      ilLinkGetNumParents(), ilLinkGetParent(), ilLinkGetPtrProp(),
  249.      ilLinkGetRelatedChild(), ilLinkGetRelatedDelete(),
  250.      ilLinkGetRelatedType(), ilLinkGetStatus(), ilLinkIsAllowed(),
  251.      ilLinkIsAltered(), ilLinkIsEnabled(), ilLinkIsRelated(), ilLinkIsSet(),
  252.      ilLinkRemoveParent(), ilLinkRemoveProp(), ilLinkSetDescription(),
  253.      ilLinkSetDisabledIndex(), ilLinkSetEnabled(), ilLinkSetParent(),
  254.      ilLinkSetProp(), ilLinkSetRelatedDelete(), ilLinkSetRelatedType()
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg((((3333))))
  269.  
  270.  
  271.  
  272. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.